Package com.cisco.pt.ipc.sim.impl
Class STPProcessImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ProcessImpl
com.cisco.pt.ipc.sim.impl.STPProcessImpl
- All Implemented Interfaces:
IPCObject,Process,STPProcess
Information provided by the PKI file:
\class StpProcess
\brief StpProcess handles and manipulates STP processes.
\example network().getDevice("Switch0").getProcess("StpMainProcess").getStpProcess(1)
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionSTPProcessImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionintInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.sim.impl.ProcessImpl
getOwnerDeviceMethods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSessionMethods inherited from interface com.cisco.pt.ipc.sim.Process
getOwnerDevice
-
Constructor Details
-
STPProcessImpl
public STPProcessImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getSwitchPriority
public int getSwitchPriority()Information provided by the PKI file:
\brief Returns the priority. \return int, the priority.- Specified by:
getSwitchPriorityin interfaceSTPProcess- Returns:
- int Returns a int
-
getRootBridgeId
Information provided by the PKI file:
\brief Returns the root bridge ID. \return string, the root bridge ID.- Specified by:
getRootBridgeIdin interfaceSTPProcess- Returns:
- String Returns a String
-
getPortCount
public int getPortCount()Information provided by the PKI file:
\brief Returns the number of ports in the STP process. \return int, the number of ports in the STP process.- Specified by:
getPortCountin interfaceSTPProcess- Returns:
- int Returns a int
-
isRootBridge
public boolean isRootBridge()Information provided by the PKI file:
\brief Returns true if this switch is the root bridge, otherwise false. \return bool, true if this switch is the root bridge, otherwise false.- Specified by:
isRootBridgein interfaceSTPProcess- Returns:
- boolean Returns a boolean
-
getSwitchId
Information provided by the PKI file:
\brief Returns the ID for this switch. \return string, the ID for this switch.- Specified by:
getSwitchIdin interfaceSTPProcess- Returns:
- String Returns a String
-
hasPort
Information provided by the PKI file:
\brief Returns true if the specified port is in this STP process, otherwise false. \param portName, portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return bool, true if the specified port is in this STP process, otherwise false.- Specified by:
hasPortin interfaceSTPProcess- Parameters:
portName- Takes in a parameter of portName- Returns:
- boolean Returns a boolean
-
getRootPort
Information provided by the PKI file:
\brief Returns the root port in this STP process. \return SwitchPort, the SwitchPort object.- Specified by:
getRootPortin interfaceSTPProcess- Returns:
- SwitchPort Returns a SwitchPort
-
getRootPathCost
public int getRootPathCost()Information provided by the PKI file:
\brief Returns the root path cost. \return int, the root path cost.- Specified by:
getRootPathCostin interfaceSTPProcess- Returns:
- int Returns a int
-